FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.us.hsds#current (78 ms)

Package hl7.fhir.us.hsds
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/hsds/https://build.fhir.org/ig/HL7/FHIR-IG-Human-Services-Directory/CapabilityStatement-HumanServicesDirectory.html
Url http://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory
Version 1.0.0
Status draft
Date 2023-08-05
Name HumanServicesDirectoryCapabilityStatement
Title Human Services Directory Capability Statement
Experimental False
Realm us
Authority hl7
Description Describes the expected capabilities of the Human Services Directory Server actor responsible for providing responses to the queries submitted by the Human Services Directory Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Human Services Directory (HSD) Servers are defined.
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

ImplementationGuide
hl7.fhir.us.hsds FHIR Human Services Directory
http://hl7.org/fhir/us/hsds/SearchParameter/healthcareservice-communication HSD_sp_healthcareservice_communication
http://hl7.org/fhir/us/hsds/SearchParameter/healthcareservice-program HSD_sp_healthcareservice_program
http://hl7.org/fhir/us/hsds/SearchParameter/location-accessibility HSD_sp_location_accessibility
http://hl7.org/fhir/us/hsds/SearchParameter/location-address-city HSD_sp_location_address_city
http://hl7.org/fhir/us/hsds/SearchParameter/location-address-country HSD_sp_location_address_country
http://hl7.org/fhir/us/hsds/SearchParameter/location-address-postalcode HSD_sp_location_address_postalcode
http://hl7.org/fhir/us/hsds/SearchParameter/location-address-state HSD_sp_location_address_state
http://hl7.org/fhir/us/hsds/SearchParameter/location-address HSD_sp_location_address
http://hl7.org/fhir/us/hsds/SearchParameter/location-hoursofoperation HSD_sp_location_hoursofoperation
http://hl7.org/fhir/us/hsds/SearchParameter/location-name HSD_sp_location_name
http://hl7.org/fhir/us/hsds/SearchParameter/location-organization HSD_sp_location_organization
http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-city HSD_sp_organization_address_city
http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-postalcode HSD_sp_organization_address_postalcode
http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-state HSD_sp_organization_address_state
http://hl7.org/fhir/us/hsds/SearchParameter/organization-address HSD_sp_organization_address
http://hl7.org/fhir/us/hsds/SearchParameter/organization-identifier HSD_sp_organization_identifier
http://hl7.org/fhir/us/hsds/SearchParameter/organization-name HSD_sp_organization_name
http://hl7.org/fhir/us/hsds/SearchParameter/organization-type HSD_sp_organization_type
http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-HealthcareService HSDHealthcareService
http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Location HSDLocation
http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Organization HSDOrganization


Narrative

Note: links and images are rebased to the (stated) source

Human Services Directory CapabilityStatement

  • Official URL:http://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory
  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Intended Use: Requirements
  • Supported Formats: XML, JSON
  • Published: 2023-08-16
  • Published by: HL7 Human and Social Services Working Group (HSSWG)
  • Status: Draft

This section describes the expected capabilities of the Human Services Directory Server actor responsible for providing responses to the queries submitted by the Human Services Directory Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Human Services Directory Servers are defined.

RESTful Capabilities by Resource/Profile:

Summary of Search Criteria

Resource TypeSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
OrganizationHSD Organizationaddress-city, address-postalcode, address-state, address-country, name, type, identifier, _id, _lastUpdatedHealthcareService:organization, Location:organization
LocationHSD Locationaccessibility, address-city, address-postalcode, address-state, address-country, name, organization, hoursofoperation, _id, _lastUpdatedLocation:organizationHealthcareService:location
HealthcareServiceHSD HealthcareServicecommunication, location, name, organization, program, service-category, service-type, active, _id, _lastUpdatedHealthcareService:location, HealthcareService:organization

Organization

Conformance Expectation: SHALL

HSD Organization

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Organization resource using:
    GET [base]/Organization/[id]
  • A Server SHOULD be capable of returning a Organization resource using:
    GET [base]/Organization/[id]/_history/vid
  • A Server SHALL be capable of supporting the following _includes:
    N/A
  • A Server SHALL be capable of supporting the following _revincludes:
    HealthcareService:organization - GET [base]/Organization?[parameter=value]&_revinclude=HealthcareService:organization
    Location:organization - GET [base]/Organization?[parameter=value]&_revinclude=Location:organization

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLnamestringGET [base]/Organization?name=[name]
SHALLtypetokenGET [base]/Organization?type=[system]|[code]
SHALLaddress-citystringGET [base]/Organization?address-city=[address-city]
SHALLidentifierstringGET [base]/Organization?identifier=[identifier]
SHALLaddress-postalcodestringGET [base]/Organization?address-postalcode=[address-postalcode]
SHALLaddress-statestringGET [base]/Organization?address-state=[address-state]
SHALLaddress-countrystringGET [base]/Organization?address-country=[address-country]
SHALL_idtokenGET [base]/Organization?_id=[id]
SHALL_lastUpdateddateGET [base]/Organization?_lastUpdated=[_lastUpdated]

Location

Conformance Expectation: SHALL

Supported Profiles: HSD Location

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Location resource using:
    GET [base]/Location/[id]
  • A Server SHOULD be capable of returning a Location resource using:
    GET [base]/Location/[id]/_history/vid
  • A Server SHALL be capable of supporting the following _includes:
    Location:organization - GET [base]/Location?[parameter=value]&_include=Location:organization
  • A Server SHALL be capable of supporting the following _revincludes:
    HealthcareService:location - GET [base]/Location?[parameter=value]&_revinclude=HealthcareService:location

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLnamereferenceGET [base]/Location?name=[name]
SHALLorganizationreferenceGET [base]/Location?organization=[organization]
SHALLhoursofoperationreferenceGET [base]/Location?hoursofoperation=[hoursofoperation]
SHALLaccessibilityreferenceGET [base]/Location?accessibility=[accessibility]
SHALLaddress-citystringGET [base]/Location?address-city=[address-city]
SHALLaddress-statestringGET [base]/Location?address-state=[address-state]
SHALLaddress-postalcodestringGET [base]/Location?address-postalcode=[address-postalcode]
SHALLaddress-countrystringGET [base]/Location?address-country=[address-country]
SHALL_idtokenGET [base]/Location?_id=[id]
SHALL_lastUpdateddateGET [base]/Location?_lastUpdated=[_lastUpdated]

HealthcareService

Conformance Expectation: SHALL

Supported Profiles: HSD HealthcareService

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a HealthcareService resource using:
    GET [base]/HealthcareService/[id]
  • A Server SHOULD be capable of returning a HealthcareService resource using:
    GET [base]/HealthcareService/[id]/_history/vid
  • A Server SHALL be capable of supporting the following _includes:
    HealthcareService:location - GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:location
    HealthcareService:organization - GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:organization
  • A Server SHALL be capable of supporting the following _revincludes:
    N/A

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLnamereferenceGET [base]/HealthcareService?name=[name]
SHALLorganizationreferenceGET [base]/HealthcareService?organization=[organization]
SHALLlocationreferenceGET [base]/HealthcareService?location=[location]
SHALLprogramstringGET [base]/HealthcareService?program=[program]
SHALLcommunicationtokenGET [base]/HealthcareService?communication=[system]|[code]
SHALLservice-categorytokenGET [base]/HealthcareService?service-category=[system]|[code]
SHALLservice-typetokenGET [base]/HealthcareService?service-type=[system]|[code]
SHALLactivestringGET [base]/HealthcareService?active=[active]
SHALL_idtokenGET [base]/HealthcareService?_id=[id]
SHALL_lastUpdateddateGET [base]/HealthcareService?_lastUpdated=[_lastUpdated]



Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "HumanServicesDirectory",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">Human Services Directory CapabilityStatement</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory</code></li><li><b>Implementation Guide Version:</b> 1.0.0</li><li><b>FHIR Version:</b> 4.0.1</li><li><b>Intended Use:</b> Requirements</li><li><b>Supported Formats:</b> XML, JSON</li><li><b>Published:</b> 2023-08-16</li><li><b>Published by:</b> HL7 Human and Social Services Working Group (HSSWG)</li><li><b>Status:</b> Draft</li></ul><p>This section describes the expected capabilities of the Human Services Directory Server actor responsible for providing responses to the queries submitted by the Human Services Directory Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Human Services Directory Servers are defined.</p><h3 id=\"resource--details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary of Search Criteria</strong></p><table class=\"grid\"><thead><tr><th>Resource Type</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href=\"#organization\">Organization</a></td><td><a href=\"StructureDefinition-hsds-Organization.html\">HSD Organization</a></td><td>address-city, address-postalcode, address-state, address-country, name, type, identifier, _id, _lastUpdated</td><td></td><td>HealthcareService:organization, Location:organization</td><td></td></tr><tr><td><a href=\"#location\">Location</a></td><td><a href=\"StructureDefinition-hsds-Location.html\">HSD Location</a></td><td>accessibility, address-city, address-postalcode, address-state, address-country, name, organization, hoursofoperation, _id, _lastUpdated</td><td>Location:organization</td><td>HealthcareService:location</td><td></td></tr><tr><td><a href=\"#healthcareservice\">HealthcareService</a></td><td><a href=\"StructureDefinition-hsds-HealthcareService.html\">HSD HealthcareService</a></td><td>communication, location, name, organization, program, service-category, service-type, active, _id, _lastUpdated</td><td>HealthcareService:location, HealthcareService:organization</td><td/><td/></tr></tbody></table><hr/><h4 id=\"organization\" class=\"no_toc\">Organization</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p><a href=\"StructureDefinition-hsds-Organization.html\">HSD Organization</a></p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning a Organization resource using:<br/><code class=\"highlighter-rouge\">GET [base]/Organization/[id]</code></li><li>A Server <strong>SHOULD</strong> be capable of returning a Organization resource using:<br/><code class=\"highlighter-rouge\">GET [base]/Organization/[id]/_history/vid</code></li> <!-- Only SHALL for include for now the capability statement does not create the primitive \t\t\t\t extensios for this yet. --><li>A Server <strong>SHALL</strong> be capable of supporting the following _includes:<br/>N/A<br/></li> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --><li>A Server <strong>SHALL</strong> be capable of supporting the following _revincludes:<br/>HealthcareService:organization - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=HealthcareService:organization</code><br/>Location:organization - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=Location:organization</code><br/></li></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-name.html\">name</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?name=[name]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-type.html\">type</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?type=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-address-city.html\">address-city</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?address-city=[address-city]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-identifier.html\">identifier</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?identifier=[identifier]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-address-postalcode.html\">address-postalcode</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?address-postalcode=[address-postalcode]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-address-state.html\">address-state</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?address-state=[address-state]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-address-country.html\">address-country</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?address-country=[address-country]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?_lastUpdated=[_lastUpdated]</code></td></tr></tbody></table><hr/><h4 id=\"location\" class=\"no_toc\">Location</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles: <a href=\"StructureDefinition-hsds-Location.html\">HSD Location</a></p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning a Location resource using:<br/><code class=\"highlighter-rouge\">GET [base]/Location/[id]</code></li><li>A Server <strong>SHOULD</strong> be capable of returning a Location resource using:<br/><code class=\"highlighter-rouge\">GET [base]/Location/[id]/_history/vid</code></li> <!-- Only SHALL for include for now the capability statement does not create the primitive \t\t\t\t extensios for this yet. --><li>A Server <strong>SHALL</strong> be capable of supporting the following _includes:<br/>Location:organization - <code class=\"highlighter-rouge\">GET [base]/Location?[parameter=value]&amp;_include=Location:organization</code><br/></li> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --><li>A Server <strong>SHALL</strong> be capable of supporting the following _revincludes:<br/>HealthcareService:location - <code class=\"highlighter-rouge\">GET [base]/Location?[parameter=value]&amp;_revinclude=HealthcareService:location</code><br/></li></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-name.html\">name</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Location?name=[name]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-organization.html\">organization</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Location?organization=[organization]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-hoursofoperation.html\">hoursofoperation</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Location?hoursofoperation=[hoursofoperation]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-accessibility.html\">accessibility</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Location?accessibility=[accessibility]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-address-city.html\">address-city</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Location?address-city=[address-city]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-address-state.html\">address-state</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Location?address-state=[address-state]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-address-postalcode.html\">address-postalcode</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Location?address-postalcode=[address-postalcode]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-address-country.html\">address-country</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Location?address-country=[address-country]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Location?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Location?_lastUpdated=[_lastUpdated]</code></td></tr></tbody></table><hr/><h4 id=\"healthcareservice\" class=\"no_toc\">HealthcareService</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles: <a href=\"StructureDefinition-hsds-HealthcareService.html\">HSD HealthcareService</a></p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning a HealthcareService resource using:<br/><code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]</code></li><li>A Server <strong>SHOULD</strong> be capable of returning a HealthcareService resource using:<br/><code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]/_history/vid</code></li><li>A Server <strong>SHALL</strong> be capable of supporting the following _includes:<br/>HealthcareService:location - <code class=\"highlighter-rouge\">GET [base]/HealthcareService?[parameter=value]&amp;_include=HealthcareService:location</code><br/>HealthcareService:organization - <code class=\"highlighter-rouge\">GET [base]/HealthcareService?[parameter=value]&amp;_include=HealthcareService:organization</code><br/></li> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --><li>A Server <strong>SHALL</strong> be capable of supporting the following _revincludes:<br/>N/A<br/></li></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-name.html\">name</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?name=[name]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-organization.html\">organization</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?organization=[organization]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-location.html\">location</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?location=[location]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-program.html\">program</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?program=[program]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-communication.html\">communication</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?communication=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-service-category.html\">service-category</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?service-category=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-service-type.html\">service-type</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?service-type=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-active.html\">active</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?active=[active]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?_lastUpdated=[_lastUpdated]</code></td></tr></tbody></table><hr/><br/></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "hss"
    }
  ],
  "url" : "http://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory",
  "version" : "1.0.0",
  "name" : "HumanServicesDirectoryCapabilityStatement",
  "title" : "Human Services Directory Capability Statement",
  "status" : "draft",
  "experimental" : false,
  "date" : "2023-08-05",
  "publisher" : "HL7 Human and Social Services Work Group",
  "contact" : [
    {
      "name" : "HL7 Human and Social Services Work Group",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/hsswg/index.cfm"
        },
        {
          "system" : "email",
          "value" : "hsswg@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "Describes the expected capabilities of the Human Services Directory Server actor responsible for providing responses to the queries submitted by the Human Services Directory Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Human Services Directory (HSD) Servers are defined.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "xml",
    "json"
  ],
  "patchFormat" : [
    "application/json-patch+json"
  ],
  "implementationGuide" : [
    "http://hl7.org/fhir/us/hsds/ImplementationGuide/hl7.fhir.us.hsds"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "Description of the needed resources to be supported by the FHIR server, and the different possible interactions.",
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Location",
          "profile" : "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Location",
          "documentation" : "Read a location (details and position information) for a physical place where human and social services are provided.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "vread"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/location-name",
              "type" : "string",
              "documentation" : "Search for locations by a portion of the location's name or alias."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address.country",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-country",
              "type" : "string",
              "documentation" : "Search for locations by a country specified in an address."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "hoursofoperation",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/location-hoursofoperation",
              "type" : "string",
              "documentation" : "Search for locations by hours of operation."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "accessibility",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/location-accessibility",
              "type" : "token",
              "documentation" : "Search for locations by accessibiity options."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/location-address",
              "type" : "string",
              "documentation" : "Search for locations by a (part of the) address of the location."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address-city",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-city",
              "type" : "string",
              "documentation" : "Search for locations by city specified in an address."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address-state",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-state",
              "type" : "string",
              "documentation" : "Search for locations by state specified in an address."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address-postalcode",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-postalcode",
              "type" : "string",
              "documentation" : "Search for locations by postal code specified in an address."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "organization",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/location-organization",
              "type" : "reference",
              "documentation" : "Search for locations that are managed by the specified organization."
            }
          ]
        },
        {
          "type" : "Organization",
          "profile" : "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Organization",
          "documentation" : "Read a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "vread"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address",
              "type" : "string",
              "documentation" : "Search for organizations specified in an address."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address.postalCode",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-postalcode",
              "type" : "string",
              "documentation" : "Search for organizations by postal code specified in an address."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address.state",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-state",
              "type" : "string",
              "documentation" : "Search for organizations by state specified in an address."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address.city",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-city",
              "type" : "string",
              "documentation" : "Search for organizations by city specified in an address."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/organization-identifier",
              "type" : "token",
              "documentation" : "Search for organizations by tax identifier (business indentifier) associated with human services organizations."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/organization-name",
              "type" : "string",
              "documentation" : "Search for organizations by a portion of the organization's name or alias."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "type",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/organization-type",
              "type" : "token",
              "documentation" : "Search for organizations by (a code for) the type of organization."
            }
          ]
        },
        {
          "type" : "HealthcareService",
          "profile" : "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-HealthcareService",
          "documentation" : "Read the details of human and social services resources that are available at a location.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "vread"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "communication",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/healthcareservice-communication",
              "type" : "string",
              "documentation" : "Search for human and social services by the language in which services are delivered."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "program",
              "definition" : "http://hl7.org/fhir/us/hsds/SearchParameter/healthcareservice-program",
              "type" : "token",
              "documentation" : "Search for human and social services by the program under which this service is delivered."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "category",
              "definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-service-category",
              "type" : "token",
              "documentation" : "Search for human and social services by the specified category of service."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "type",
              "definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-service-type",
              "type" : "token",
              "documentation" : "Search for human and social services by the specified type of service."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "active",
              "type" : "token",
              "documentation" : "Search for human and social services by the specified status of service."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "type" : "string",
              "documentation" : "Search for human and social services by the specified status for the service."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "location",
              "type" : "reference",
              "documentation" : "Search for human and social services offered at the specified location."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "organization",
              "type" : "reference",
              "documentation" : "Search for human and social services offered by the specified organization."
            }
          ]
        }
      ],
      "interaction" : [
        {
          "code" : "transaction"
        },
        {
          "code" : "search-system"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.